home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIModule.idl < prev    next >
Text File  |  2006-05-08  |  4KB  |  116 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40. interface nsIFile;
  41. interface nsIComponentManager;
  42.  
  43. /**
  44.  * The nsIModule interface.
  45.  * @status FROZEN
  46.  */
  47.  
  48. [scriptable, uuid(7392D032-5371-11d3-994E-00805FD26FEE)]
  49. interface nsIModule : nsISupports
  50. {
  51.     /** 
  52.      * Object Instance Creation
  53.      *
  54.      * Obtains a Class Object from a nsIModule for a given CID and IID pair.  
  55.      * This class object can either be query to a nsIFactory or a may be 
  56.      * query to a nsIClassInfo.
  57.      *
  58.      * @param aCompMgr  : The global component manager
  59.      * @param aClass    : ClassID of object instance requested
  60.      * @param aIID      : IID of interface requested
  61.      * 
  62.      */
  63.     void getClassObject(in nsIComponentManager aCompMgr, 
  64.                         in nsCIDRef aClass,
  65.                         in nsIIDRef aIID,
  66.                         [retval, iid_is(aIID)] out nsQIResult aResult);
  67.  
  68.  
  69.     /**
  70.      * One time registration callback
  71.      *
  72.      * When the nsIModule is discovered, this method will be
  73.      * called so that any setup registration can be preformed.
  74.      *
  75.      * @param aCompMgr  : The global component manager
  76.      * @param aLocation : The location of the nsIModule on disk
  77.      * @param aLoaderStr: Opaque loader specific string
  78.      * @param aType     : Loader Type being used to load this module 
  79.      */
  80.     void registerSelf(in nsIComponentManager aCompMgr, 
  81.                       in nsIFile aLocation,
  82.                       in string aLoaderStr, 
  83.                       in string aType);
  84.     /**
  85.      * One time unregistration callback
  86.      *
  87.      * When the nsIModule is being unregistered, this method will be
  88.      * called so that any unregistration can be preformed
  89.      *
  90.      * @param aCompMgr   : The global component manager
  91.      * @param aLocation  : The location of the nsIModule on disk
  92.      * @param aLoaderStr : Opaque loader specific string
  93.      * 
  94.      */
  95.    void unregisterSelf(in nsIComponentManager aCompMgr, 
  96.                         in nsIFile aLocation,
  97.                         in string  aLoaderStr);
  98.  
  99.    /** 
  100.     * Module load management
  101.     * 
  102.     * @param aCompMgr  : The global component manager
  103.     *
  104.     * @return indicates to the caller if the module can be unloaded.
  105.     *         Returning PR_TRUE isn't a guarantee that the module will be
  106.     *        unloaded. It constitues only willingness of the module to be
  107.     *        unloaded.  It is very important to ensure that no outstanding 
  108.     *       references to the module's code/data exist before returning 
  109.     *       PR_TRUE. 
  110.     *        Returning PR_FALSE guaratees that the module wont be unloaded.
  111.     */
  112.     boolean canUnload(in nsIComponentManager aCompMgr);
  113. };
  114.  
  115.  
  116.